home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / subjct30.zip / SUBJECT.DOC < prev    next >
Text File  |  1990-10-10  |  12KB  |  265 lines
  1.         SUBJECT.EXE - Documentation Page 1
  2.  
  3.  
  4.         
  5.         SUBJECT Version 3.0
  6.         ~~~~~~~~~~~~~~~~~~~
  7.         A Freely available RBBS-PC Conference Messages utility
  8.         [SUBJCT30.ZIP]
  9.         by Vaishnava dasa -- 10/10/90
  10.         Krishna Yoga Foundation BBS - FidoNet 1:115/800 - 312/743-6116
  11.  
  12.           Use: Scans RBBS-PC messages files and writes a file listing 
  13.         the most popular threads in descending order. Various formating 
  14.         options included.
  15.  
  16.         SUBJECT.EXE can be used to create automatically a text file 
  17.         showing the number of messages per thread in a RBBS-PC Messages 
  18.         file. The output file can then be used as the Conference's 
  19.         WELCOME file.
  20.  
  21.         DISCLAIMER
  22.         ~~~~~~~~~~
  23.           There is no guarantee that SUBJECT.EXE will work with RBBS-PC 
  24.         in all circumstances or with all hardware configurations. Source 
  25.         code is provided to see if the RBBS-PC SysOp will find 
  26.         SUBJECT.EXE useful. No one has ever reported any harm when using 
  27.         SUBJECT.EXE. SUBJECT.EXE is released freely into the Public 
  28.         Domain for anyone to use any way he sees fit. Vaishnava dasa, 
  29.         the author of SUBJECT.EXE, will not make any claim to 
  30.         proprietorship on this code. The idea behind SUBJECT.EXE is 
  31.         solely to support the idea of making RBBS-PC suit the needs and 
  32.         creativity of the RBBS-PC SysOp. 
  33.  
  34.         WHAT'S NEW in this Version of SUBJECT.EXE?
  35.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36.           Use this Version of SUBJECT.EXE especially compatible with 
  37.         RBBS-PC.EXE Version 17.3. Earlier versions of SUBJECT.EXE didn't 
  38.         know if RBBS-PC.EXE supported finding *WG.DEF and *WC.DEF 
  39.         WELCOME files when using Conferences or Subboards. Now 
  40.         SUBJECT.EXE supports the simultaneous creation of *W.DEF, 
  41.         *WG.DEF and *WC.DEF files if the name of the Conference/Subboard 
  42.         is 6 characters or less. Version 3.0 of SUBJECT.EXE is not fully 
  43.         backwards compatible with earlier versions of SUBJECT.EXE. This 
  44.         version of SUBJECT.EXE is ideal when used with Mike Zakarhoff's 
  45.         MSGTOSS Fast RBBS-PC mail tosser. Once you have created Template 
  46.         files to your liking, or even if you use the default samples 
  47.         included in this ZIPped archive, MSGTOSS will automatically 
  48.         invoke SUBJECT.EXE and all WELCOME files will be created without 
  49.         any maintenance on the SysOp's part.
  50.           Version 3.0 is NOT backwardly compatible to previous versions 
  51.         of SUBJECT.EXE. Template files (*.TMP) must be used to format 
  52.         your WELCOME files. No longer are the command-line switches S:, 
  53.         F:, D:, or L: supported. A couple minor bug fixes are also fixed 
  54.         with this version. 
  55.           Also, SUBJECT.EXE's template files' format has been changed to 
  56.         support subjects that are 25 characters in length. All previous 
  57.         versions supported 20 character subjects only. 
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                       1
  65.  
  66.  
  67.         SUBJECT.EXE - Documentation Page 2
  68.  
  69.  
  70.         Files Included in this archive:
  71.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  72.         SUBJECT.EXE - Executable program
  73.         SUBJECT.DOC - This text file
  74.         SUBJECT.BAS - QuickBASIC Version 4.5 source code
  75.         SUBJECT.TMP - Sample non-graphics Template file
  76.         SUBJECTG.TMP - Sample ASCII-Graphics Template file
  77.         SUBJECTC.TMP - Sample Color-Graphics Template file
  78.  
  79.         Format:
  80.         ~~~~~~
  81.         SUBJECT I:<file> O:<file> C:<name> (? = Help)
  82.  
  83.         Examples:
  84.         ~~~~~~~~
  85.         SUBJECT I:c:\rbbs\rbbspcm.def O:rbbspcw.def C:rbbspc 
  86.         SUBJECT I:binkm.def O:binkw.def C:binkleyterm 
  87.  
  88.         Required command-line parameters:
  89.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  90.         I: - Input file. Name of RBBS-PC Messages file to read. Usually 
  91.         this file is the full name (and optional path) of a RBBS-PC 
  92.         Conference Messages file. SUBJECT.EXE reads this Messages files 
  93.         SUBJECT field, strips out any occurances of "(R)", sorts the 
  94.         SUBJECTs, computes the total messages for each particular 
  95.         SUBJECT, then writes the information to a formatted Output file, 
  96.         specified by the O: parameter. When creating an Output file, 
  97.         SUBJECT.EXE will not include any SUBJECTs that are SUBJECTs of 
  98.         messages which are marked as private or killed. Also, if 
  99.         SUBJECT.EXE has any difficulty reading or finding the specified 
  100.         input file, it will create a file called SUBJECT.ERR in the 
  101.         default directory from which SUBJECT.EXE is run and detail the 
  102.         error for debugging purposes. If SUBJECT.ERR already exists, the 
  103.         error information will just be appended to SUBJECT.ERR.
  104.  
  105.         O: - Output file. Name (and optional path) of output file to be 
  106.         created by SUBJECT.EXE. Use the same name as the RBBS-PC 
  107.         Conference file (up to 6 characters) and add "W.DEF" so that the 
  108.         Output file will automatically display as user enters the 
  109.         Conference. For example, if the Conference Messages file is 
  110.         COOKNGM.DEF, set the O: parameter to create the COOKNGW.DEF 
  111.         Conference WELCOME file. RBBS-PC will automatically display the 
  112.         <conference name>W.DEF file. By specifying a drive and path in 
  113.         this O: parameter, SUBJECT.EXE can create the Output file in the 
  114.         subdirectory where RBBS-PC will be able to locate it and display 
  115.         it (usually in the same directory as RBBS-PC.EXE and the 
  116.         <conference name>M.DEF Conference Messages file is located.) If 
  117.         no drive and path are specified, the Output file is created in 
  118.         the same directory from which SUBJECT.EXE is run.
  119.  
  120.         C: - Conference name to be used in Output file header. Do NOT 
  121.         use any [SPACE] characters. The Conference name as appearing in 
  122.         the Output file will be in fully capitalized regardless of how 
  123.         the Conference name appears on SUBJECT.EXE's C: command line 
  124.         parameter (see examples below). If the Conference name contains 
  125.         more than one word, an underline character can usually 
  126.         substitute for a space character. For example, if the Conference 
  127.         name is "HOME REPAIR", you must change the name so that no space 
  128.  
  129.  
  130.                                       2
  131.  
  132.  
  133.         SUBJECT.EXE - Documentation Page 3
  134.  
  135.  
  136.         characters appear in the name. "HOME_REPAIR" with the underline 
  137.         character substituted for the space is a very good substitution.
  138.  
  139.         Optional parameters:
  140.         ~~~~~~~~~~~~~~~~~~~
  141.         ? - Small help screen
  142.          
  143.         Template file substitutions:
  144.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  145.         o SUBJECT890123456789012345 - SUBJECT header is substituted 
  146.             always beginning with the most popular SUBJECT
  147.         o MSG - 3 character total number of public messages in the 
  148.             specified message base
  149.         o AREA - Up to 20 characters of the AREA name of the message 
  150.             base
  151.         o FMDATExx - 8 character Date of earliest message in message 
  152.             base in the format of MM-DD-YY
  153.         o TODATExx - 8 character Date of most recent message in message     
  154.             base in the format of MM-DD-YY
  155.         o ### - 3 character number of messages under one SUBJECT. Number     
  156.             of messages under one SUBJECT always begins with the  
  157.             greatest number of messages. 
  158.  
  159.           SUBJECT.EXE substitues these various strings with real values, 
  160.         and creates a file determined by the O: parameter and other 
  161.         command-line switches. If the Output filename specified in the 
  162.         O: parameter is in the format "<6 letters-or-less Conference 
  163.         Name> + W.DEF", the resultant Output filename is called "<6 
  164.         letters-or-less Conference Name>". The optional path specified 
  165.         in the O: parameter is also preserved.
  166.           The Template file used by SUBJECT.EXE may be one of two files. 
  167.         SUBJECT.EXE looks on the default drive for "<6 letters-or-less 
  168.         Conference name> + .TMP" first, and, if not found, then 
  169.         SUBJECT.EXE looks for the default file called SUBJECT.TMP and 
  170.         uses it. This facility is there for those SysOps who want to 
  171.         have a special WELCOME file for any given Conference. Of course, 
  172.         if SUBJECT.EXE cannot find either .TMP file in the default 
  173.         drive/(subdirectory), then SUBJECT.EXE reports an error, and 
  174.         aborts any further processing. For any RBBS-PC messages file in 
  175.         the format of *M.DEF which has seven characters as the name of 
  176.         the Conference/echo (e.g. COOKING), SUBJECT.EXE will NOT produce 
  177.         any ASCII and ASNI Graphics WELCOME files. Only 
  178.         Conferences/echo-names with six letters or less will allow 
  179.         SUBJECT.EXE to produce the wanted non-graphics, ASCII and ANSI 
  180.         WELCOME files. 
  181.           All Conferences/Subboards can have their own individual 
  182.         Template file. SUBJECT.EXE will search for the existence in the 
  183.         default directory for the <6 letters-or-less Conference Name> + 
  184.         *.TMP Template files. If SUBJECT.EXE cannot find it, it will 
  185.         then look for the default Template files, namely, SUBJECT.TMP, 
  186.         SUBJECTG.TMP and SUBJECTC.TMP. If SUBJECT.EXE cannot find these 
  187.         files, SUBJECT.EXE will report an Error, and update or create 
  188.         the SUBJECT.ERR file on the default drive.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                                       3
  197.  
  198.  
  199.         SUBJECT.EXE - Documentation Page 4
  200.  
  201.  
  202.         Example 1 - Sample Non-Graphics Template File:
  203.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  204.         (see SUBJECT.TMP)
  205.  
  206.         Example 2 - Sample ASCII Graphics Template File:
  207.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  208.         (see SUBJECTG.TMP)
  209.  
  210.         Example 3 - Sample Color Graphics Template File:
  211.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  212.         (see SUBJECTC.TMP)
  213.  
  214.         Short Discussion about SUBJECT and MSGTOSS:
  215.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  216.         SUBJECT.EXE performs quite well with Mike Zakharoff's new 
  217.         MSGTOSS Net/Echomail Tosser. SUBJECT.EXE can be invoked via 
  218.         MSGTOSS.CFG using MSGTOSS's variables: [MSGFILE], [WELFILE], and 
  219.         [AREA]. SUBJECT.EXE will create WELCOME files for Conferences or 
  220.         Subboards, or even a combination of the two, producing files 
  221.         with SMART-TEXT, Ascii Graphics, Color Graphics or non-graphics 
  222.         formats automatically without the SysOps help once these 
  223.         parameters are set.
  224.  
  225.         Example 4 - Sample use with MSGTOSS 
  226.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  227.         (For more information about MSGTOSS, contact the Interstate BBS 
  228.         Network at 206/631-7813, Mike Zakharoff, SysOp.)
  229.  
  230.         In MSGTOSS.CFG, use:
  231.  
  232.         UTIL1CMD---->SUBJECT I:[MSGFILE] O:[WELFILE] C:[AREA] 
  233.  
  234.         For example, if [MSGFILE] = "RBBSPCM.DEF", [WELFILE] would 
  235.         default to "RBBSPCW.DEF" and [AREA] would be "RBBS-PC". 
  236.           The preferred method is to use a Conference name that is 6 
  237.         letters or less. The result would be the creation of 
  238.         "RBBSPCW.DEF," "RBBSPCWG.DEF," and "RBBSPCWC.DEF" so that RBBS-
  239.         PC.EXE Version 17.3 would find these three different files and 
  240.         display them for the User according to what graphics/non-
  241.         graphics option he has set for each and every Conference/Subbord 
  242.         that he uses.
  243.  
  244.         - end -
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                       4
  263.  
  264.  
  265.